<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>SC2API: sc2::ControlInterface Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="SC2-Logo.png"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">SC2API
   </div>
   <div id="projectbrief">An API for AI for StarCraft II</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><b>sc2</b></li><li class="navelem"><a class="el" href="classsc2_1_1_control_interface.html">ControlInterface</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classsc2_1_1_control_interface-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">sc2::ControlInterface Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div>  </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ab90c8107014b8da21ba1d88fdb35aada"><td class="memItemLeft" align="right" valign="top"><a id="ab90c8107014b8da21ba1d88fdb35aada"></a>
virtual <a class="el" href="classsc2_1_1_proto_interface.html">ProtoInterface</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>Proto</b> ()=0</td></tr>
<tr class="separator:ab90c8107014b8da21ba1d88fdb35aada"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2e8bb94501a1772bfd98f8feb45180d4"><td class="memItemLeft" align="right" valign="top"><a id="a2e8bb94501a1772bfd98f8feb45180d4"></a>
virtual bool&#160;</td><td class="memItemRight" valign="bottom"><b>Connect</b> (const std::string &amp;address, int port, int timeout_ms)=0</td></tr>
<tr class="separator:a2e8bb94501a1772bfd98f8feb45180d4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afc307e6dc47a1cbbeb47055b199fe3e1"><td class="memItemLeft" align="right" valign="top"><a id="afc307e6dc47a1cbbeb47055b199fe3e1"></a>
virtual bool&#160;</td><td class="memItemRight" valign="bottom"><b>RemoteSaveMap</b> (const void *data, int data_size, std::string remote_path)=0</td></tr>
<tr class="separator:afc307e6dc47a1cbbeb47055b199fe3e1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4cd74e4ecacb4fad4aa35b749fd03863"><td class="memItemLeft" align="right" valign="top"><a id="a4cd74e4ecacb4fad4aa35b749fd03863"></a>
virtual bool&#160;</td><td class="memItemRight" valign="bottom"><b>CreateGame</b> (const std::string &amp;map_path, const std::vector&lt; <a class="el" href="structsc2_1_1_player_setup.html">PlayerSetup</a> &gt; &amp;players, bool realtime)=0</td></tr>
<tr class="separator:a4cd74e4ecacb4fad4aa35b749fd03863"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4a2e65b28281bfc5024a62f1a4fba99e"><td class="memItemLeft" align="right" valign="top"><a id="a4a2e65b28281bfc5024a62f1a4fba99e"></a>
virtual bool&#160;</td><td class="memItemRight" valign="bottom"><b>RequestJoinGame</b> (<a class="el" href="structsc2_1_1_player_setup.html">PlayerSetup</a> setup, const <a class="el" href="structsc2_1_1_interface_settings.html">InterfaceSettings</a> &amp;settings, const <a class="el" href="structsc2_1_1_ports.html">Ports</a> &amp;ports=<a class="el" href="structsc2_1_1_ports.html">Ports</a>())=0</td></tr>
<tr class="separator:a4a2e65b28281bfc5024a62f1a4fba99e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adddde8ba93c8a71d3af5cf38e83e7e9e"><td class="memItemLeft" align="right" valign="top"><a id="adddde8ba93c8a71d3af5cf38e83e7e9e"></a>
virtual bool&#160;</td><td class="memItemRight" valign="bottom"><b>WaitJoinGame</b> ()=0</td></tr>
<tr class="separator:adddde8ba93c8a71d3af5cf38e83e7e9e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab4fbb92be4e178ab662770155c7b0cd0"><td class="memItemLeft" align="right" valign="top"><a id="ab4fbb92be4e178ab662770155c7b0cd0"></a>
virtual bool&#160;</td><td class="memItemRight" valign="bottom"><b>RequestLeaveGame</b> ()=0</td></tr>
<tr class="separator:ab4fbb92be4e178ab662770155c7b0cd0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9858c7bc4cf9485e958d96e518bd5268"><td class="memItemLeft" align="right" valign="top"><a id="a9858c7bc4cf9485e958d96e518bd5268"></a>
virtual bool&#160;</td><td class="memItemRight" valign="bottom"><b>PollLeaveGame</b> ()=0</td></tr>
<tr class="separator:a9858c7bc4cf9485e958d96e518bd5268"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac4051c302ac0aff7892b7b3dac834bff"><td class="memItemLeft" align="right" valign="top"><a id="ac4051c302ac0aff7892b7b3dac834bff"></a>
virtual bool&#160;</td><td class="memItemRight" valign="bottom"><b>Step</b> (int count=1)=0</td></tr>
<tr class="separator:ac4051c302ac0aff7892b7b3dac834bff"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afdceac1202a0160a4bb8bcea6ab227c1"><td class="memItemLeft" align="right" valign="top"><a id="afdceac1202a0160a4bb8bcea6ab227c1"></a>
virtual bool&#160;</td><td class="memItemRight" valign="bottom"><b>WaitStep</b> ()=0</td></tr>
<tr class="separator:afdceac1202a0160a4bb8bcea6ab227c1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3e9f1c13939a03abccfc73191cc7fdcf"><td class="memItemLeft" align="right" valign="top"><a id="a3e9f1c13939a03abccfc73191cc7fdcf"></a>
virtual bool&#160;</td><td class="memItemRight" valign="bottom"><b>SaveReplay</b> (const std::string &amp;path)=0</td></tr>
<tr class="separator:a3e9f1c13939a03abccfc73191cc7fdcf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a98c730f6414edaa5166890dede1fe83c"><td class="memItemLeft" align="right" valign="top"><a id="a98c730f6414edaa5166890dede1fe83c"></a>
virtual bool&#160;</td><td class="memItemRight" valign="bottom"><b>Ping</b> ()=0</td></tr>
<tr class="separator:a98c730f6414edaa5166890dede1fe83c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a02fe1bf89ffb788392bf7707ba9fc049"><td class="memItemLeft" align="right" valign="top"><a id="a02fe1bf89ffb788392bf7707ba9fc049"></a>
virtual GameResponsePtr&#160;</td><td class="memItemRight" valign="bottom"><b>WaitForResponse</b> ()=0</td></tr>
<tr class="separator:a02fe1bf89ffb788392bf7707ba9fc049"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a869db0749b2f5db41731886cc7fe9d87"><td class="memItemLeft" align="right" valign="top"><a id="a869db0749b2f5db41731886cc7fe9d87"></a>
virtual void&#160;</td><td class="memItemRight" valign="bottom"><b>SetProcessInfo</b> (const <a class="el" href="structsc2_1_1_process_info.html">ProcessInfo</a> &amp;pi)=0</td></tr>
<tr class="separator:a869db0749b2f5db41731886cc7fe9d87"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a190f45b9169d5e17cdf48cc906bd70e3"><td class="memItemLeft" align="right" valign="top"><a id="a190f45b9169d5e17cdf48cc906bd70e3"></a>
virtual const <a class="el" href="structsc2_1_1_process_info.html">ProcessInfo</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>GetProcessInfo</b> () const =0</td></tr>
<tr class="separator:a190f45b9169d5e17cdf48cc906bd70e3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7856754a90ef19fce1c37d532940cc70"><td class="memItemLeft" align="right" valign="top"><a id="a7856754a90ef19fce1c37d532940cc70"></a>
virtual AppState&#160;</td><td class="memItemRight" valign="bottom"><b>GetAppState</b> () const =0</td></tr>
<tr class="separator:a7856754a90ef19fce1c37d532940cc70"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9cb258851dc5ab3ac7abe7bd817c9531"><td class="memItemLeft" align="right" valign="top"><a id="a9cb258851dc5ab3ac7abe7bd817c9531"></a>
virtual SC2APIProtocol::Status&#160;</td><td class="memItemRight" valign="bottom"><b>GetLastStatus</b> () const =0</td></tr>
<tr class="separator:a9cb258851dc5ab3ac7abe7bd817c9531"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a334adf0a34284e32833554fa189d9746"><td class="memItemLeft" align="right" valign="top"><a id="a334adf0a34284e32833554fa189d9746"></a>
virtual bool&#160;</td><td class="memItemRight" valign="bottom"><b>IsInGame</b> () const =0</td></tr>
<tr class="separator:a334adf0a34284e32833554fa189d9746"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8b00eb5fe681665c39855cc3b481ed92"><td class="memItemLeft" align="right" valign="top"><a id="a8b00eb5fe681665c39855cc3b481ed92"></a>
virtual bool&#160;</td><td class="memItemRight" valign="bottom"><b>IsFinishedGame</b> () const =0</td></tr>
<tr class="separator:a8b00eb5fe681665c39855cc3b481ed92"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4bc92e6d97dbe3bd91c93bdf4a450155"><td class="memItemLeft" align="right" valign="top"><a id="a4bc92e6d97dbe3bd91c93bdf4a450155"></a>
virtual bool&#160;</td><td class="memItemRight" valign="bottom"><b>IsReadyForCreateGame</b> () const =0</td></tr>
<tr class="separator:a4bc92e6d97dbe3bd91c93bdf4a450155"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a470cbcfd519ee228c024a9b59a9bbb74"><td class="memItemLeft" align="right" valign="top"><a id="a470cbcfd519ee228c024a9b59a9bbb74"></a>
virtual bool&#160;</td><td class="memItemRight" valign="bottom"><b>HasResponsePending</b> () const =0</td></tr>
<tr class="separator:a470cbcfd519ee228c024a9b59a9bbb74"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4c66296192ffa3e1ba8c3ad2a17d8380"><td class="memItemLeft" align="right" valign="top"><a id="a4c66296192ffa3e1ba8c3ad2a17d8380"></a>
virtual bool&#160;</td><td class="memItemRight" valign="bottom"><b>GetObservation</b> ()=0</td></tr>
<tr class="separator:a4c66296192ffa3e1ba8c3ad2a17d8380"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa6f27ad05d20d610c2d4e5b70fc68b49"><td class="memItemLeft" align="right" valign="top"><a id="aa6f27ad05d20d610c2d4e5b70fc68b49"></a>
virtual bool&#160;</td><td class="memItemRight" valign="bottom"><b>PollResponse</b> ()=0</td></tr>
<tr class="separator:aa6f27ad05d20d610c2d4e5b70fc68b49"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa8bb71f36fd5106eb21bbceb1ecedf4d"><td class="memItemLeft" align="right" valign="top"><a id="aa8bb71f36fd5106eb21bbceb1ecedf4d"></a>
virtual bool&#160;</td><td class="memItemRight" valign="bottom"><b>ConsumeResponse</b> ()=0</td></tr>
<tr class="separator:aa8bb71f36fd5106eb21bbceb1ecedf4d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a03c1b68afb1521abf804d2a120f91880"><td class="memItemLeft" align="right" valign="top"><a id="a03c1b68afb1521abf804d2a120f91880"></a>
virtual bool&#160;</td><td class="memItemRight" valign="bottom"><b>IssueEvents</b> (const std::vector&lt; Tag &gt; &amp;commands={})=0</td></tr>
<tr class="separator:a03c1b68afb1521abf804d2a120f91880"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a251ee28b1676960c086dc748c52723a3"><td class="memItemLeft" align="right" valign="top"><a id="a251ee28b1676960c086dc748c52723a3"></a>
virtual void&#160;</td><td class="memItemRight" valign="bottom"><b>OnGameStart</b> ()=0</td></tr>
<tr class="separator:a251ee28b1676960c086dc748c52723a3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aac30977133be8ffe2a749a920149b5d3"><td class="memItemLeft" align="right" valign="top"><a id="aac30977133be8ffe2a749a920149b5d3"></a>
virtual void&#160;</td><td class="memItemRight" valign="bottom"><b>DumpProtoUsage</b> ()=0</td></tr>
<tr class="separator:aac30977133be8ffe2a749a920149b5d3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab3e7b964d0f7e90cc239e5997b09b5c4"><td class="memItemLeft" align="right" valign="top"><a id="ab3e7b964d0f7e90cc239e5997b09b5c4"></a>
virtual void&#160;</td><td class="memItemRight" valign="bottom"><b>Error</b> (<a class="el" href="sc2__client_8h.html#ac7d3e3694a208204e099f04c1e5eded0">ClientError</a> error, const std::vector&lt; std::string &gt; &amp;errors={})=0</td></tr>
<tr class="separator:ab3e7b964d0f7e90cc239e5997b09b5c4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0f3a503c5e2ed951eed1774866a0280f"><td class="memItemLeft" align="right" valign="top"><a id="a0f3a503c5e2ed951eed1774866a0280f"></a>
virtual void&#160;</td><td class="memItemRight" valign="bottom"><b>ErrorIf</b> (bool condition, <a class="el" href="sc2__client_8h.html#ac7d3e3694a208204e099f04c1e5eded0">ClientError</a> error, const std::vector&lt; std::string &gt; &amp;errors={})=0</td></tr>
<tr class="separator:a0f3a503c5e2ed951eed1774866a0280f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac033fdc8fb4d4aa50a174b6d8870a143"><td class="memItemLeft" align="right" valign="top"><a id="ac033fdc8fb4d4aa50a174b6d8870a143"></a>
virtual const std::vector&lt; <a class="el" href="sc2__client_8h.html#ac7d3e3694a208204e099f04c1e5eded0">ClientError</a> &gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>GetClientErrors</b> () const =0</td></tr>
<tr class="separator:ac033fdc8fb4d4aa50a174b6d8870a143"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac26497e85a0dc55ae82270f0f50d5f03"><td class="memItemLeft" align="right" valign="top"><a id="ac26497e85a0dc55ae82270f0f50d5f03"></a>
virtual const std::vector&lt; std::string &gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>GetProtocolErrors</b> () const =0</td></tr>
<tr class="separator:ac26497e85a0dc55ae82270f0f50d5f03"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8873d48c9aea76578115f4d5d1fbdbf5"><td class="memItemLeft" align="right" valign="top"><a id="a8873d48c9aea76578115f4d5d1fbdbf5"></a>
virtual void&#160;</td><td class="memItemRight" valign="bottom"><b>ClearClientErrors</b> ()=0</td></tr>
<tr class="separator:a8873d48c9aea76578115f4d5d1fbdbf5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0b7042768e8b428f867b9069281e8c66"><td class="memItemLeft" align="right" valign="top"><a id="a0b7042768e8b428f867b9069281e8c66"></a>
virtual void&#160;</td><td class="memItemRight" valign="bottom"><b>ClearProtocolErrors</b> ()=0</td></tr>
<tr class="separator:a0b7042768e8b428f867b9069281e8c66"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae1a7f651dbd994f99d75fb6315b5c688"><td class="memItemLeft" align="right" valign="top"><a id="ae1a7f651dbd994f99d75fb6315b5c688"></a>
virtual void&#160;</td><td class="memItemRight" valign="bottom"><b>UseGeneralizedAbility</b> (bool value)=0</td></tr>
<tr class="separator:ae1a7f651dbd994f99d75fb6315b5c688"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>include/sc2api/<a class="el" href="sc2__control__interfaces_8h_source.html">sc2_control_interfaces.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>
